/////////////////////////////////////////////////////////////////////////////
//
//  Core Detours Functionality (detours.h of detours.lib)
//
//  Microsoft Research Detours Package, Version 4.0.1
//
//  Copyright (c) Microsoft Corporation.  All rights reserved.
//

#pragma once
#ifndef _DETOURS_H_
#    define _DETOURS_H_

#    define DETOURS_VERSION 0x4c0c1  // 0xMAJORcMINORcPATCH

//////////////////////////////////////////////////////////////////////////////
//

#    undef DETOURS_X64
#    undef DETOURS_X86
#    undef DETOURS_IA64
#    undef DETOURS_ARM
#    undef DETOURS_ARM64
#    undef DETOURS_BITS
#    undef DETOURS_32BIT
#    undef DETOURS_64BIT

#    if defined(_X86_)
#        define DETOURS_X86
#        define DETOURS_OPTION_BITS 64

#    elif defined(_AMD64_)
#        define DETOURS_X64
#        define DETOURS_OPTION_BITS 32

#    elif defined(_IA64_)
#        define DETOURS_IA64
#        define DETOURS_OPTION_BITS 32

#    elif defined(_ARM_)
#        define DETOURS_ARM

#    elif defined(_ARM64_)
#        define DETOURS_ARM64

#    else
#        error Unknown architecture (x86, amd64, ia64, arm, arm64)
#    endif

#    ifdef _WIN64
#        undef DETOURS_32BIT
#        define DETOURS_64BIT 1
#        define DETOURS_BITS 64
// If all 64bit kernels can run one and only one 32bit architecture.
//#define DETOURS_OPTION_BITS 32
#    else
#        define DETOURS_32BIT 1
#        undef DETOURS_64BIT
#        define DETOURS_BITS 32
// If all 64bit kernels can run one and only one 32bit architecture.
//#define DETOURS_OPTION_BITS 32
#    endif

#    define VER_DETOURS_BITS DETOUR_STRINGIFY(DETOURS_BITS)

//////////////////////////////////////////////////////////////////////////////
//

#    if (_MSC_VER < 1299)
typedef LONG LONG_PTR;
typedef ULONG ULONG_PTR;
#    endif

///////////////////////////////////////////////// SAL 2.0 Annotations w/o SAL.
//
//  These definitions are include so that Detours will build even if the
//  compiler doesn't have full SAL 2.0 support.
//
#    ifndef DETOURS_DONT_REMOVE_SAL_20

#        ifdef DETOURS_TEST_REMOVE_SAL_20
#            undef _Analysis_assume_
#            undef _Benign_race_begin_
#            undef _Benign_race_end_
#            undef _Field_range_
#            undef _Field_size_
#            undef _In_
#            undef _In_bytecount_
#            undef _In_count_
#            undef _In_opt_
#            undef _In_opt_bytecount_
#            undef _In_opt_count_
#            undef _In_opt_z_
#            undef _In_range_
#            undef _In_reads_
#            undef _In_reads_bytes_
#            undef _In_reads_opt_
#            undef _In_reads_opt_bytes_
#            undef _In_reads_or_z_
#            undef _In_z_
#            undef _Inout_
#            undef _Inout_opt_
#            undef _Inout_z_count_
#            undef _Out_
#            undef _Out_opt_
#            undef _Out_writes_
#            undef _Outptr_result_maybenull_
#            undef _Readable_bytes_
#            undef _Success_
#            undef _Writable_bytes_
#            undef _Pre_notnull_
#        endif

#        if defined(_Deref_out_opt_z_) && !defined(_Outptr_result_maybenull_)
#            define _Outptr_result_maybenull_ _Deref_out_opt_z_
#        endif

#        if defined(_In_count_) && !defined(_In_reads_)
#            define _In_reads_(x) _In_count_(x)
#        endif

#        if defined(_In_opt_count_) && !defined(_In_reads_opt_)
#            define _In_reads_opt_(x) _In_opt_count_(x)
#        endif

#        if defined(_In_opt_bytecount_) && !defined(_In_reads_opt_bytes_)
#            define _In_reads_opt_bytes_(x) _In_opt_bytecount_(x)
#        endif

#        if defined(_In_bytecount_) && !defined(_In_reads_bytes_)
#            define _In_reads_bytes_(x) _In_bytecount_(x)
#        endif

#        ifndef _In_
#            define _In_
#        endif

#        ifndef _In_bytecount_
#            define _In_bytecount_(x)
#        endif

#        ifndef _In_count_
#            define _In_count_(x)
#        endif

#        ifndef _In_opt_
#            define _In_opt_
#        endif

#        ifndef _In_opt_bytecount_
#            define _In_opt_bytecount_(x)
#        endif

#        ifndef _In_opt_count_
#            define _In_opt_count_(x)
#        endif

#        ifndef _In_opt_z_
#            define _In_opt_z_
#        endif

#        ifndef _In_range_
#            define _In_range_(x, y)
#        endif

#        ifndef _In_reads_
#            define _In_reads_(x)
#        endif

#        ifndef _In_reads_bytes_
#            define _In_reads_bytes_(x)
#        endif

#        ifndef _In_reads_opt_
#            define _In_reads_opt_(x)
#        endif

#        ifndef _In_reads_opt_bytes_
#            define _In_reads_opt_bytes_(x)
#        endif

#        ifndef _In_reads_or_z_
#            define _In_reads_or_z_
#        endif

#        ifndef _In_z_
#            define _In_z_
#        endif

#        ifndef _Inout_
#            define _Inout_
#        endif

#        ifndef _Inout_opt_
#            define _Inout_opt_
#        endif

#        ifndef _Inout_z_count_
#            define _Inout_z_count_(x)
#        endif

#        ifndef _Out_
#            define _Out_
#        endif

#        ifndef _Out_opt_
#            define _Out_opt_
#        endif

#        ifndef _Out_writes_
#            define _Out_writes_(x)
#        endif

#        ifndef _Outptr_result_maybenull_
#            define _Outptr_result_maybenull_
#        endif

#        ifndef _Writable_bytes_
#            define _Writable_bytes_(x)
#        endif

#        ifndef _Readable_bytes_
#            define _Readable_bytes_(x)
#        endif

#        ifndef _Success_
#            define _Success_(x)
#        endif

#        ifndef _Pre_notnull_
#            define _Pre_notnull_
#        endif

#        ifdef DETOURS_INTERNAL

#            pragma warning(disable : 4615)  // unknown warning type (suppress with older compilers)

#            ifndef _Benign_race_begin_
#                define _Benign_race_begin_
#            endif

#            ifndef _Benign_race_end_
#                define _Benign_race_end_
#            endif

#            ifndef _Field_size_
#                define _Field_size_(x)
#            endif

#            ifndef _Field_range_
#                define _Field_range_(x, y)
#            endif

#            ifndef _Analysis_assume_
#                define _Analysis_assume_(x)
#            endif

#        endif  // DETOURS_INTERNAL
#    endif      // DETOURS_DONT_REMOVE_SAL_20

//////////////////////////////////////////////////////////////////////////////
//
#    ifndef GUID_DEFINED
#        define GUID_DEFINED
typedef struct _GUID {
    DWORD Data1;
    WORD Data2;
    WORD Data3;
    BYTE Data4[8];
} GUID;

#        ifdef INITGUID
#            define DEFINE_GUID(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8) \
                const GUID name = {l, w1, w2, {b1, b2, b3, b4, b5, b6, b7, b8}}
#        else
#            define DEFINE_GUID(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8) const GUID name
#        endif  // INITGUID
#    endif      // !GUID_DEFINED

#    if defined(__cplusplus)
#        ifndef _REFGUID_DEFINED
#            define _REFGUID_DEFINED
#            define REFGUID const GUID &
#        endif  // !_REFGUID_DEFINED
#    else       // !__cplusplus
#        ifndef _REFGUID_DEFINED
#            define _REFGUID_DEFINED
#            define REFGUID const GUID *const
#        endif  // !_REFGUID_DEFINED
#    endif      // !__cplusplus

#    ifndef ARRAYSIZE
#        define ARRAYSIZE(x) (sizeof(x) / sizeof(x[0]))
#    endif

//
//////////////////////////////////////////////////////////////////////////////

#    ifdef __cplusplus
extern "C" {
#    endif  // __cplusplus

/////////////////////////////////////////////////// Instruction Target Macros.
//
#    define DETOUR_INSTRUCTION_TARGET_NONE ((PVOID)0)
#    define DETOUR_INSTRUCTION_TARGET_DYNAMIC ((PVOID)(LONG_PTR)-1)
#    define DETOUR_SECTION_HEADER_SIGNATURE 0x00727444  // "Dtr\0"

extern const GUID DETOUR_EXE_RESTORE_GUID;
extern const GUID DETOUR_EXE_HELPER_GUID;

#    define DETOUR_TRAMPOLINE_SIGNATURE 0x21727444  // Dtr!
typedef struct _DETOUR_TRAMPOLINE DETOUR_TRAMPOLINE, *PDETOUR_TRAMPOLINE;

/////////////////////////////////////////////////////////// Binary Structures.
//
#    pragma pack(push, 8)
typedef struct _DETOUR_SECTION_HEADER {
    DWORD cbHeaderSize;
    DWORD nSignature;
    DWORD nDataOffset;
    DWORD cbDataSize;

    DWORD nOriginalImportVirtualAddress;
    DWORD nOriginalImportSize;
    DWORD nOriginalBoundImportVirtualAddress;
    DWORD nOriginalBoundImportSize;

    DWORD nOriginalIatVirtualAddress;
    DWORD nOriginalIatSize;
    DWORD nOriginalSizeOfImage;
    DWORD cbPrePE;

    DWORD nOriginalClrFlags;
    DWORD reserved1;
    DWORD reserved2;
    DWORD reserved3;

    // Followed by cbPrePE bytes of data.
} DETOUR_SECTION_HEADER, *PDETOUR_SECTION_HEADER;

typedef struct _DETOUR_SECTION_RECORD {
    DWORD cbBytes;
    DWORD nReserved;
    GUID guid;
} DETOUR_SECTION_RECORD, *PDETOUR_SECTION_RECORD;

typedef struct _DETOUR_CLR_HEADER {
    // Header versioning
    ULONG cb;
    USHORT MajorRuntimeVersion;
    USHORT MinorRuntimeVersion;

    // Symbol table and startup information
    IMAGE_DATA_DIRECTORY MetaData;
    ULONG Flags;

    // Followed by the rest of the IMAGE_COR20_HEADER
} DETOUR_CLR_HEADER, *PDETOUR_CLR_HEADER;

typedef struct _DETOUR_EXE_RESTORE {
    DWORD cb;
    DWORD cbidh;
    DWORD cbinh;
    DWORD cbclr;

    PBYTE pidh;
    PBYTE pinh;
    PBYTE pclr;

    IMAGE_DOS_HEADER idh;
    union
    {
        IMAGE_NT_HEADERS inh;
        IMAGE_NT_HEADERS32 inh32;
        IMAGE_NT_HEADERS64 inh64;
        BYTE raw[sizeof(IMAGE_NT_HEADERS64) + sizeof(IMAGE_SECTION_HEADER) * 32];
    };
    DETOUR_CLR_HEADER clr;

} DETOUR_EXE_RESTORE, *PDETOUR_EXE_RESTORE;

typedef struct _DETOUR_EXE_HELPER {
    DWORD cb;
    DWORD pid;
    DWORD nDlls;
    CHAR rDlls[4];
} DETOUR_EXE_HELPER, *PDETOUR_EXE_HELPER;

#    pragma pack(pop)

#    define DETOUR_SECTION_HEADER_DECLARE(cbSectionSize)                    \
        {                                                                   \
            sizeof(DETOUR_SECTION_HEADER), DETOUR_SECTION_HEADER_SIGNATURE, \
                sizeof(DETOUR_SECTION_HEADER), (cbSectionSize),             \
                                                                            \
                0, 0, 0, 0,                                                 \
                                                                            \
                0, 0, 0, 0,                                                 \
        }

/////////////////////////////////////////////////////////////// Helper Macros.
//
#    define DETOURS_STRINGIFY(x) DETOURS_STRINGIFY_(x)
#    define DETOURS_STRINGIFY_(x) #    x

///////////////////////////////////////////////////////////// Binary Typedefs.
//
typedef BOOL(CALLBACK *PF_DETOUR_BINARY_BYWAY_CALLBACK)(
    _In_opt_ PVOID pContext,
    _In_opt_ LPCSTR pszFile,
    _Outptr_result_maybenull_ LPCSTR *ppszOutFile);

typedef BOOL(CALLBACK *PF_DETOUR_BINARY_FILE_CALLBACK)(
    _In_opt_ PVOID pContext,
    _In_ LPCSTR pszOrigFile,
    _In_ LPCSTR pszFile,
    _Outptr_result_maybenull_ LPCSTR *ppszOutFile);

typedef BOOL(CALLBACK *PF_DETOUR_BINARY_SYMBOL_CALLBACK)(
    _In_opt_ PVOID pContext,
    _In_ ULONG nOrigOrdinal,
    _In_ ULONG nOrdinal,
    _Out_ ULONG *pnOutOrdinal,
    _In_opt_ LPCSTR pszOrigSymbol,
    _In_opt_ LPCSTR pszSymbol,
    _Outptr_result_maybenull_ LPCSTR *ppszOutSymbol);

typedef BOOL(CALLBACK *PF_DETOUR_BINARY_COMMIT_CALLBACK)(_In_opt_ PVOID pContext);

typedef BOOL(CALLBACK *PF_DETOUR_ENUMERATE_EXPORT_CALLBACK)(_In_opt_ PVOID pContext,
                                                            _In_ ULONG nOrdinal,
                                                            _In_opt_ LPCSTR pszName,
                                                            _In_opt_ PVOID pCode);

typedef BOOL(CALLBACK *PF_DETOUR_IMPORT_FILE_CALLBACK)(_In_opt_ PVOID pContext,
                                                       _In_opt_ HMODULE hModule,
                                                       _In_opt_ LPCSTR pszFile);

typedef BOOL(CALLBACK *PF_DETOUR_IMPORT_FUNC_CALLBACK)(_In_opt_ PVOID pContext,
                                                       _In_ DWORD nOrdinal,
                                                       _In_opt_ LPCSTR pszFunc,
                                                       _In_opt_ PVOID pvFunc);

// Same as PF_DETOUR_IMPORT_FUNC_CALLBACK but extra indirection on last parameter.
typedef BOOL(CALLBACK *PF_DETOUR_IMPORT_FUNC_CALLBACK_EX)(_In_opt_ PVOID pContext,
                                                          _In_ DWORD nOrdinal,
                                                          _In_opt_ LPCSTR pszFunc,
                                                          _In_opt_ PVOID *ppvFunc);

typedef VOID *PDETOUR_BINARY;
typedef VOID *PDETOUR_LOADED_BINARY;

//////////////////////////////////////////////////////////// Transaction APIs.
//
LONG WINAPI DetourTransactionBegin(VOID);
LONG WINAPI DetourTransactionAbort(VOID);
LONG WINAPI DetourTransactionCommit(VOID);
LONG WINAPI DetourTransactionCommitEx(_Out_opt_ PVOID **pppFailedPointer);

LONG WINAPI DetourUpdateThread(_In_ HANDLE hThread);

LONG WINAPI DetourAttach(_Inout_ PVOID *ppPointer, _In_ PVOID pDetour);

LONG WINAPI DetourAttachEx(_Inout_ PVOID *ppPointer,
                           _In_ PVOID pDetour,
                           _Out_opt_ PDETOUR_TRAMPOLINE *ppRealTrampoline,
                           _Out_opt_ PVOID *ppRealTarget,
                           _Out_opt_ PVOID *ppRealDetour);

LONG WINAPI DetourDetach(_Inout_ PVOID *ppPointer, _In_ PVOID pDetour);

BOOL WINAPI DetourSetIgnoreTooSmall(_In_ BOOL fIgnore);
BOOL WINAPI DetourSetRetainRegions(_In_ BOOL fRetain);
PVOID WINAPI DetourSetSystemRegionLowerBound(_In_ PVOID pSystemRegionLowerBound);
PVOID WINAPI DetourSetSystemRegionUpperBound(_In_ PVOID pSystemRegionUpperBound);

////////////////////////////////////////////////////////////// Code Functions.
//
PVOID WINAPI DetourFindFunction(_In_ LPCSTR pszModule, _In_ LPCSTR pszFunction);
PVOID WINAPI DetourCodeFromPointer(_In_ PVOID pPointer, _Out_opt_ PVOID *ppGlobals);
PVOID WINAPI DetourCopyInstruction(_In_opt_ PVOID pDst,
                                   _Inout_opt_ PVOID *ppDstPool,
                                   _In_ PVOID pSrc,
                                   _Out_opt_ PVOID *ppTarget,
                                   _Out_opt_ LONG *plExtra);
BOOL WINAPI DetourSetCodeModule(_In_ HMODULE hModule, _In_ BOOL fLimitReferencesToModule);

///////////////////////////////////////////////////// Loaded Binary Functions.
//
HMODULE WINAPI DetourGetContainingModule(_In_ PVOID pvAddr);
HMODULE WINAPI DetourEnumerateModules(_In_opt_ HMODULE hModuleLast);
PVOID WINAPI DetourGetEntryPoint(_In_opt_ HMODULE hModule);
ULONG WINAPI DetourGetModuleSize(_In_opt_ HMODULE hModule);
BOOL WINAPI DetourEnumerateExports(_In_ HMODULE hModule,
                                   _In_opt_ PVOID pContext,
                                   _In_ PF_DETOUR_ENUMERATE_EXPORT_CALLBACK pfExport);
BOOL WINAPI DetourEnumerateImports(_In_opt_ HMODULE hModule,
                                   _In_opt_ PVOID pContext,
                                   _In_opt_ PF_DETOUR_IMPORT_FILE_CALLBACK pfImportFile,
                                   _In_opt_ PF_DETOUR_IMPORT_FUNC_CALLBACK pfImportFunc);

BOOL WINAPI DetourEnumerateImportsEx(_In_opt_ HMODULE hModule,
                                     _In_opt_ PVOID pContext,
                                     _In_opt_ PF_DETOUR_IMPORT_FILE_CALLBACK pfImportFile,
                                     _In_opt_ PF_DETOUR_IMPORT_FUNC_CALLBACK_EX pfImportFuncEx);

_Writable_bytes_(*pcbData) _Readable_bytes_(*pcbData) _Success_(return != NULL) PVOID WINAPI
    DetourFindPayload(_In_opt_ HMODULE hModule, _In_ REFGUID rguid, _Out_ DWORD *pcbData);

_Writable_bytes_(*pcbData) _Readable_bytes_(*pcbData) _Success_(return != NULL) PVOID WINAPI
    DetourFindPayloadEx(_In_ REFGUID rguid, _Out_ DWORD *pcbData);

DWORD WINAPI DetourGetSizeOfPayloads(_In_opt_ HMODULE hModule);

///////////////////////////////////////////////// Persistent Binary Functions.
//

PDETOUR_BINARY WINAPI DetourBinaryOpen(_In_ HANDLE hFile);

_Writable_bytes_(*pcbData) _Readable_bytes_(*pcbData) _Success_(return != NULL) PVOID WINAPI
    DetourBinaryEnumeratePayloads(_In_ PDETOUR_BINARY pBinary,
                                  _Out_opt_ GUID *pGuid,
                                  _Out_ DWORD *pcbData,
                                  _Inout_ DWORD *pnIterator);

_Writable_bytes_(*pcbData) _Readable_bytes_(*pcbData) _Success_(return != NULL) PVOID WINAPI
    DetourBinaryFindPayload(_In_ PDETOUR_BINARY pBinary, _In_ REFGUID rguid, _Out_ DWORD *pcbData);

PVOID WINAPI DetourBinarySetPayload(_In_ PDETOUR_BINARY pBinary,
                                    _In_ REFGUID rguid,
                                    _In_reads_opt_(cbData) PVOID pData,
                                    _In_ DWORD cbData);
BOOL WINAPI DetourBinaryDeletePayload(_In_ PDETOUR_BINARY pBinary, _In_ REFGUID rguid);
BOOL WINAPI DetourBinaryPurgePayloads(_In_ PDETOUR_BINARY pBinary);
BOOL WINAPI DetourBinaryResetImports(_In_ PDETOUR_BINARY pBinary);
BOOL WINAPI DetourBinaryEditImports(_In_ PDETOUR_BINARY pBinary,
                                    _In_opt_ PVOID pContext,
                                    _In_opt_ PF_DETOUR_BINARY_BYWAY_CALLBACK pfByway,
                                    _In_opt_ PF_DETOUR_BINARY_FILE_CALLBACK pfFile,
                                    _In_opt_ PF_DETOUR_BINARY_SYMBOL_CALLBACK pfSymbol,
                                    _In_opt_ PF_DETOUR_BINARY_COMMIT_CALLBACK pfCommit);
BOOL WINAPI DetourBinaryWrite(_In_ PDETOUR_BINARY pBinary, _In_ HANDLE hFile);
BOOL WINAPI DetourBinaryClose(_In_ PDETOUR_BINARY pBinary);

/////////////////////////////////////////////////// Create Process & Load Dll.
//
typedef BOOL(WINAPI *PDETOUR_CREATE_PROCESS_ROUTINEA)(
    _In_opt_ LPCSTR lpApplicationName,
    _Inout_opt_ LPSTR lpCommandLine,
    _In_opt_ LPSECURITY_ATTRIBUTES lpProcessAttributes,
    _In_opt_ LPSECURITY_ATTRIBUTES lpThreadAttributes,
    _In_ BOOL bInheritHandles,
    _In_ DWORD dwCreationFlags,
    _In_opt_ LPVOID lpEnvironment,
    _In_opt_ LPCSTR lpCurrentDirectory,
    _In_ LPSTARTUPINFOA lpStartupInfo,
    _Out_ LPPROCESS_INFORMATION lpProcessInformation);

typedef BOOL(WINAPI *PDETOUR_CREATE_PROCESS_ROUTINEW)(
    _In_opt_ LPCWSTR lpApplicationName,
    _Inout_opt_ LPWSTR lpCommandLine,
    _In_opt_ LPSECURITY_ATTRIBUTES lpProcessAttributes,
    _In_opt_ LPSECURITY_ATTRIBUTES lpThreadAttributes,
    _In_ BOOL bInheritHandles,
    _In_ DWORD dwCreationFlags,
    _In_opt_ LPVOID lpEnvironment,
    _In_opt_ LPCWSTR lpCurrentDirectory,
    _In_ LPSTARTUPINFOW lpStartupInfo,
    _Out_ LPPROCESS_INFORMATION lpProcessInformation);

BOOL WINAPI DetourCreateProcessWithDllA(_In_opt_ LPCSTR lpApplicationName,
                                        _Inout_opt_ LPSTR lpCommandLine,
                                        _In_opt_ LPSECURITY_ATTRIBUTES lpProcessAttributes,
                                        _In_opt_ LPSECURITY_ATTRIBUTES lpThreadAttributes,
                                        _In_ BOOL bInheritHandles,
                                        _In_ DWORD dwCreationFlags,
                                        _In_opt_ LPVOID lpEnvironment,
                                        _In_opt_ LPCSTR lpCurrentDirectory,
                                        _In_ LPSTARTUPINFOA lpStartupInfo,
                                        _Out_ LPPROCESS_INFORMATION lpProcessInformation,
                                        _In_ LPCSTR lpDllName,
                                        _In_opt_ PDETOUR_CREATE_PROCESS_ROUTINEA pfCreateProcessA);

BOOL WINAPI DetourCreateProcessWithDllW(_In_opt_ LPCWSTR lpApplicationName,
                                        _Inout_opt_ LPWSTR lpCommandLine,
                                        _In_opt_ LPSECURITY_ATTRIBUTES lpProcessAttributes,
                                        _In_opt_ LPSECURITY_ATTRIBUTES lpThreadAttributes,
                                        _In_ BOOL bInheritHandles,
                                        _In_ DWORD dwCreationFlags,
                                        _In_opt_ LPVOID lpEnvironment,
                                        _In_opt_ LPCWSTR lpCurrentDirectory,
                                        _In_ LPSTARTUPINFOW lpStartupInfo,
                                        _Out_ LPPROCESS_INFORMATION lpProcessInformation,
                                        _In_ LPCSTR lpDllName,
                                        _In_opt_ PDETOUR_CREATE_PROCESS_ROUTINEW pfCreateProcessW);

#    ifdef UNICODE
#        define DetourCreateProcessWithDll DetourCreateProcessWithDllW
#        define PDETOUR_CREATE_PROCESS_ROUTINE PDETOUR_CREATE_PROCESS_ROUTINEW
#    else
#        define DetourCreateProcessWithDll DetourCreateProcessWithDllA
#        define PDETOUR_CREATE_PROCESS_ROUTINE PDETOUR_CREATE_PROCESS_ROUTINEA
#    endif  // !UNICODE

BOOL WINAPI
DetourCreateProcessWithDllExA(_In_opt_ LPCSTR lpApplicationName,
                              _Inout_opt_ LPSTR lpCommandLine,
                              _In_opt_ LPSECURITY_ATTRIBUTES lpProcessAttributes,
                              _In_opt_ LPSECURITY_ATTRIBUTES lpThreadAttributes,
                              _In_ BOOL bInheritHandles,
                              _In_ DWORD dwCreationFlags,
                              _In_opt_ LPVOID lpEnvironment,
                              _In_opt_ LPCSTR lpCurrentDirectory,
                              _In_ LPSTARTUPINFOA lpStartupInfo,
                              _Out_ LPPROCESS_INFORMATION lpProcessInformation,
                              _In_ LPCSTR lpDllName,
                              _In_opt_ PDETOUR_CREATE_PROCESS_ROUTINEA pfCreateProcessA);

BOOL WINAPI
DetourCreateProcessWithDllExW(_In_opt_ LPCWSTR lpApplicationName,
                              _Inout_opt_ LPWSTR lpCommandLine,
                              _In_opt_ LPSECURITY_ATTRIBUTES lpProcessAttributes,
                              _In_opt_ LPSECURITY_ATTRIBUTES lpThreadAttributes,
                              _In_ BOOL bInheritHandles,
                              _In_ DWORD dwCreationFlags,
                              _In_opt_ LPVOID lpEnvironment,
                              _In_opt_ LPCWSTR lpCurrentDirectory,
                              _In_ LPSTARTUPINFOW lpStartupInfo,
                              _Out_ LPPROCESS_INFORMATION lpProcessInformation,
                              _In_ LPCSTR lpDllName,
                              _In_opt_ PDETOUR_CREATE_PROCESS_ROUTINEW pfCreateProcessW);

#    ifdef UNICODE
#        define DetourCreateProcessWithDllEx DetourCreateProcessWithDllExW
#    else
#        define DetourCreateProcessWithDllEx DetourCreateProcessWithDllExA
#    endif  // !UNICODE

BOOL WINAPI DetourCreateProcessWithDllsA(_In_opt_ LPCSTR lpApplicationName,
                                         _Inout_opt_ LPSTR lpCommandLine,
                                         _In_opt_ LPSECURITY_ATTRIBUTES lpProcessAttributes,
                                         _In_opt_ LPSECURITY_ATTRIBUTES lpThreadAttributes,
                                         _In_ BOOL bInheritHandles,
                                         _In_ DWORD dwCreationFlags,
                                         _In_opt_ LPVOID lpEnvironment,
                                         _In_opt_ LPCSTR lpCurrentDirectory,
                                         _In_ LPSTARTUPINFOA lpStartupInfo,
                                         _Out_ LPPROCESS_INFORMATION lpProcessInformation,
                                         _In_ DWORD nDlls,
                                         _In_reads_(nDlls) LPCSTR *rlpDlls,
                                         _In_opt_ PDETOUR_CREATE_PROCESS_ROUTINEA pfCreateProcessA);

BOOL WINAPI DetourCreateProcessWithDllsW(_In_opt_ LPCWSTR lpApplicationName,
                                         _Inout_opt_ LPWSTR lpCommandLine,
                                         _In_opt_ LPSECURITY_ATTRIBUTES lpProcessAttributes,
                                         _In_opt_ LPSECURITY_ATTRIBUTES lpThreadAttributes,
                                         _In_ BOOL bInheritHandles,
                                         _In_ DWORD dwCreationFlags,
                                         _In_opt_ LPVOID lpEnvironment,
                                         _In_opt_ LPCWSTR lpCurrentDirectory,
                                         _In_ LPSTARTUPINFOW lpStartupInfo,
                                         _Out_ LPPROCESS_INFORMATION lpProcessInformation,
                                         _In_ DWORD nDlls,
                                         _In_reads_(nDlls) LPCSTR *rlpDlls,
                                         _In_opt_ PDETOUR_CREATE_PROCESS_ROUTINEW pfCreateProcessW);

#    ifdef UNICODE
#        define DetourCreateProcessWithDlls DetourCreateProcessWithDllsW
#    else
#        define DetourCreateProcessWithDlls DetourCreateProcessWithDllsA
#    endif  // !UNICODE

BOOL WINAPI DetourProcessViaHelperA(_In_ DWORD dwTargetPid,
                                    _In_ LPCSTR lpDllName,
                                    _In_ PDETOUR_CREATE_PROCESS_ROUTINEA pfCreateProcessA);

BOOL WINAPI DetourProcessViaHelperW(_In_ DWORD dwTargetPid,
                                    _In_ LPCSTR lpDllName,
                                    _In_ PDETOUR_CREATE_PROCESS_ROUTINEW pfCreateProcessW);

#    ifdef UNICODE
#        define DetourProcessViaHelper DetourProcessViaHelperW
#    else
#        define DetourProcessViaHelper DetourProcessViaHelperA
#    endif  // !UNICODE

BOOL WINAPI DetourProcessViaHelperDllsA(_In_ DWORD dwTargetPid,
                                        _In_ DWORD nDlls,
                                        _In_reads_(nDlls) LPCSTR *rlpDlls,
                                        _In_ PDETOUR_CREATE_PROCESS_ROUTINEA pfCreateProcessA);

BOOL WINAPI DetourProcessViaHelperDllsW(_In_ DWORD dwTargetPid,
                                        _In_ DWORD nDlls,
                                        _In_reads_(nDlls) LPCSTR *rlpDlls,
                                        _In_ PDETOUR_CREATE_PROCESS_ROUTINEW pfCreateProcessW);

#    ifdef UNICODE
#        define DetourProcessViaHelperDlls DetourProcessViaHelperDllsW
#    else
#        define DetourProcessViaHelperDlls DetourProcessViaHelperDllsA
#    endif  // !UNICODE

BOOL WINAPI DetourUpdateProcessWithDll(_In_ HANDLE hProcess,
                                       _In_reads_(nDlls) LPCSTR *rlpDlls,
                                       _In_ DWORD nDlls);

BOOL WINAPI DetourUpdateProcessWithDllEx(_In_ HANDLE hProcess,
                                         _In_ HMODULE hImage,
                                         _In_ BOOL bIs32Bit,
                                         _In_reads_(nDlls) LPCSTR *rlpDlls,
                                         _In_ DWORD nDlls);

BOOL WINAPI DetourCopyPayloadToProcess(_In_ HANDLE hProcess,
                                       _In_ REFGUID rguid,
                                       _In_reads_bytes_(cbData) PVOID pvData,
                                       _In_ DWORD cbData);
BOOL WINAPI DetourRestoreAfterWith(VOID);
BOOL WINAPI DetourRestoreAfterWithEx(_In_reads_bytes_(cbData) PVOID pvData, _In_ DWORD cbData);
BOOL WINAPI DetourIsHelperProcess(VOID);
VOID CALLBACK DetourFinishHelperProcess(_In_ HWND, _In_ HINSTANCE, _In_ LPSTR, _In_ INT);

//
//////////////////////////////////////////////////////////////////////////////
#    ifdef __cplusplus
}
#    endif  // __cplusplus

//////////////////////////////////////////////// Detours Internal Definitions.
//
#    ifdef __cplusplus
#        ifdef DETOURS_INTERNAL

#            define NOTHROW
// #define NOTHROW (nothrow)

//////////////////////////////////////////////////////////////////////////////
//
#            if (_MSC_VER < 1299)
#                include <imagehlp.h>
typedef IMAGEHLP_MODULE IMAGEHLP_MODULE64;
typedef PIMAGEHLP_MODULE PIMAGEHLP_MODULE64;
typedef IMAGEHLP_SYMBOL SYMBOL_INFO;
typedef PIMAGEHLP_SYMBOL PSYMBOL_INFO;

static inline LONG InterlockedCompareExchange(_Inout_ LONG *ptr, _In_ LONG nval, _In_ LONG oval) {
    return (LONG)::InterlockedCompareExchange((PVOID *)ptr, (PVOID)nval, (PVOID)oval);
}
#            else
#                pragma warning(push)
#                pragma warning(disable : 4091)  // empty typedef
#                include <dbghelp.h>
#                pragma warning(pop)
#            endif

#            ifdef IMAGEAPI  // defined by DBGHELP.H
typedef LPAPI_VERSION(NTAPI *PF_ImagehlpApiVersionEx)(_In_ LPAPI_VERSION AppVersion);

typedef BOOL(NTAPI *PF_SymInitialize)(_In_ HANDLE hProcess,
                                      _In_opt_ LPCSTR UserSearchPath,
                                      _In_ BOOL fInvadeProcess);
typedef DWORD(NTAPI *PF_SymSetOptions)(_In_ DWORD SymOptions);
typedef DWORD(NTAPI *PF_SymGetOptions)(VOID);
typedef DWORD64(NTAPI *PF_SymLoadModule64)(_In_ HANDLE hProcess,
                                           _In_opt_ HANDLE hFile,
                                           _In_ LPSTR ImageName,
                                           _In_opt_ LPSTR ModuleName,
                                           _In_ DWORD64 BaseOfDll,
                                           _In_opt_ DWORD SizeOfDll);
typedef BOOL(NTAPI *PF_SymGetModuleInfo64)(_In_ HANDLE hProcess,
                                           _In_ DWORD64 qwAddr,
                                           _Out_ PIMAGEHLP_MODULE64 ModuleInfo);
typedef BOOL(NTAPI *PF_SymFromName)(_In_ HANDLE hProcess,
                                    _In_ LPSTR Name,
                                    _Out_ PSYMBOL_INFO Symbol);

typedef struct _DETOUR_SYM_INFO {
    HANDLE hProcess;
    HMODULE hDbgHelp;
    PF_ImagehlpApiVersionEx pfImagehlpApiVersionEx;
    PF_SymInitialize pfSymInitialize;
    PF_SymSetOptions pfSymSetOptions;
    PF_SymGetOptions pfSymGetOptions;
    PF_SymLoadModule64 pfSymLoadModule64;
    PF_SymGetModuleInfo64 pfSymGetModuleInfo64;
    PF_SymFromName pfSymFromName;
} DETOUR_SYM_INFO, *PDETOUR_SYM_INFO;

PDETOUR_SYM_INFO DetourLoadImageHlp(VOID);

#            endif  // IMAGEAPI

#            if defined(_INC_STDIO) && !defined(_CRT_STDIO_ARBITRARY_WIDE_SPECIFIERS)
#                error detours.h must be included before stdio.h (or at least define _CRT_STDIO_ARBITRARY_WIDE_SPECIFIERS earlier)
#            endif
#            define _CRT_STDIO_ARBITRARY_WIDE_SPECIFIERS 1

#            ifndef DETOUR_TRACE
#                if DETOUR_DEBUG
#                    define DETOUR_TRACE(x) printf x
#                    define DETOUR_BREAK() __debugbreak()
#                    include <limits.h>
#                    include <stdio.h>
#                else
#                    define DETOUR_TRACE(x)
#                    define DETOUR_BREAK()
#                endif
#            endif

#            if 1 || defined(DETOURS_IA64)

//
// IA64 instructions are 41 bits, 3 per bundle, plus 5 bit bundle template => 128 bits per bundle.
//

#                define DETOUR_IA64_INSTRUCTIONS_PER_BUNDLE (3)

#                define DETOUR_IA64_TEMPLATE_OFFSET (0)
#                define DETOUR_IA64_TEMPLATE_SIZE (5)

#                define DETOUR_IA64_INSTRUCTION_SIZE (41)
#                define DETOUR_IA64_INSTRUCTION0_OFFSET (DETOUR_IA64_TEMPLATE_SIZE)
#                define DETOUR_IA64_INSTRUCTION1_OFFSET \
                    (DETOUR_IA64_TEMPLATE_SIZE + DETOUR_IA64_INSTRUCTION_SIZE)
#                define DETOUR_IA64_INSTRUCTION2_OFFSET                         \
                    (DETOUR_IA64_TEMPLATE_SIZE + DETOUR_IA64_INSTRUCTION_SIZE + \
                     DETOUR_IA64_INSTRUCTION_SIZE)

C_ASSERT(DETOUR_IA64_TEMPLATE_SIZE +
             DETOUR_IA64_INSTRUCTIONS_PER_BUNDLE * DETOUR_IA64_INSTRUCTION_SIZE ==
         128);

__declspec(align(16)) struct DETOUR_IA64_BUNDLE {
  public:
    union
    {
        BYTE data[16];
        UINT64 wide[2];
    };

    enum {
        A_UNIT = 1u,
        I_UNIT = 2u,
        M_UNIT = 3u,
        B_UNIT = 4u,
        F_UNIT = 5u,
        L_UNIT = 6u,
        X_UNIT = 7u,
    };
    struct DETOUR_IA64_METADATA {
        ULONG nTemplate : 8;  // Instruction template.
        ULONG nUnit0 : 4;     // Unit for slot 0
        ULONG nUnit1 : 4;     // Unit for slot 1
        ULONG nUnit2 : 4;     // Unit for slot 2
    };

  protected:
    static const DETOUR_IA64_METADATA s_rceCopyTable[33];

    UINT RelocateBundle(_Inout_ DETOUR_IA64_BUNDLE *pDst,
                        _Inout_opt_ DETOUR_IA64_BUNDLE *pBundleExtra) const;

    bool RelocateInstruction(_Inout_ DETOUR_IA64_BUNDLE *pDst,
                             _In_ BYTE slot,
                             _Inout_opt_ DETOUR_IA64_BUNDLE *pBundleExtra) const;

    // 120 112 104 96 88 80 72 64 56 48 40 32 24 16  8  0
    //  f.  e.  d. c. b. a. 9. 8. 7. 6. 5. 4. 3. 2. 1. 0.

    //                                      00
    // f.e. d.c. b.a. 9.8. 7.6. 5.4. 3.2. 1.0.
    // 0000 0000 0000 0000 0000 0000 0000 001f : Template [4..0]
    // 0000 0000 0000 0000 0000 03ff ffff ffe0 : Zero [ 41..  5]
    // 0000 0000 0000 0000 0000 3c00 0000 0000 : Zero [ 45.. 42]
    // 0000 0000 0007 ffff ffff c000 0000 0000 : One  [ 82.. 46]
    // 0000 0000 0078 0000 0000 0000 0000 0000 : One  [ 86.. 83]
    // 0fff ffff ff80 0000 0000 0000 0000 0000 : Two  [123.. 87]
    // f000 0000 0000 0000 0000 0000 0000 0000 : Two  [127..124]
    BYTE GetTemplate() const;
    // Get 4 bit opcodes.
    BYTE GetInst0() const;
    BYTE GetInst1() const;
    BYTE GetInst2() const;
    BYTE GetUnit(BYTE slot) const;
    BYTE GetUnit0() const;
    BYTE GetUnit1() const;
    BYTE GetUnit2() const;
    // Get 37 bit data.
    UINT64 GetData0() const;
    UINT64 GetData1() const;
    UINT64 GetData2() const;

    // Get/set the full 41 bit instructions.
    UINT64 GetInstruction(BYTE slot) const;
    UINT64 GetInstruction0() const;
    UINT64 GetInstruction1() const;
    UINT64 GetInstruction2() const;
    void SetInstruction(BYTE slot, UINT64 instruction);
    void SetInstruction0(UINT64 instruction);
    void SetInstruction1(UINT64 instruction);
    void SetInstruction2(UINT64 instruction);

    // Get/set bitfields.
    static UINT64 GetBits(UINT64 Value, UINT64 Offset, UINT64 Count);
    static UINT64 SetBits(UINT64 Value, UINT64 Offset, UINT64 Count, UINT64 Field);

    // Get specific read-only fields.
    static UINT64 GetOpcode(UINT64 instruction);  // 4bit opcode
    static UINT64 GetX(UINT64 instruction);       // 1bit opcode extension
    static UINT64 GetX3(UINT64 instruction);      // 3bit opcode extension
    static UINT64 GetX6(UINT64 instruction);      // 6bit opcode extension

    // Get/set specific fields.
    static UINT64 GetImm7a(UINT64 instruction);
    static UINT64 SetImm7a(UINT64 instruction, UINT64 imm7a);
    static UINT64 GetImm13c(UINT64 instruction);
    static UINT64 SetImm13c(UINT64 instruction, UINT64 imm13c);
    static UINT64 GetSignBit(UINT64 instruction);
    static UINT64 SetSignBit(UINT64 instruction, UINT64 signBit);
    static UINT64 GetImm20a(UINT64 instruction);
    static UINT64 SetImm20a(UINT64 instruction, UINT64 imm20a);
    static UINT64 GetImm20b(UINT64 instruction);
    static UINT64 SetImm20b(UINT64 instruction, UINT64 imm20b);

    static UINT64 SignExtend(UINT64 Value, UINT64 Offset);

    BOOL IsMovlGp() const;

    VOID SetInst(BYTE Slot, BYTE nInst);
    VOID SetInst0(BYTE nInst);
    VOID SetInst1(BYTE nInst);
    VOID SetInst2(BYTE nInst);
    VOID SetData(BYTE Slot, UINT64 nData);
    VOID SetData0(UINT64 nData);
    VOID SetData1(UINT64 nData);
    VOID SetData2(UINT64 nData);
    BOOL SetNop(BYTE Slot);
    BOOL SetNop0();
    BOOL SetNop1();
    BOOL SetNop2();

  public:
    BOOL IsBrl() const;
    VOID SetBrl();
    VOID SetBrl(UINT64 target);
    UINT64 GetBrlTarget() const;
    VOID SetBrlTarget(UINT64 target);
    VOID SetBrlImm(UINT64 imm);
    UINT64 GetBrlImm() const;

    UINT64 GetMovlGp() const;
    VOID SetMovlGp(UINT64 gp);

    VOID SetStop();

    UINT Copy(_Out_ DETOUR_IA64_BUNDLE *pDst,
              _Inout_opt_ DETOUR_IA64_BUNDLE *pBundleExtra = NULL) const;
};
#            endif  // DETOURS_IA64

#            ifdef DETOURS_ARM

#                define DETOURS_PFUNC_TO_PBYTE(p) ((PBYTE)(((ULONG_PTR)(p)) & ~(ULONG_PTR)1))
#                define DETOURS_PBYTE_TO_PFUNC(p) ((PBYTE)(((ULONG_PTR)(p)) | (ULONG_PTR)1))

#            endif  // DETOURS_ARM

//////////////////////////////////////////////////////////////////////////////

#            ifdef __cplusplus
extern "C" {
#            endif  // __cplusplus

#            define DETOUR_OFFLINE_LIBRARY(x)                                           \
                PVOID WINAPI DetourCopyInstruction##x(                                  \
                    _In_opt_ PVOID pDst, _Inout_opt_ PVOID *ppDstPool, _In_ PVOID pSrc, \
                    _Out_opt_ PVOID *ppTarget, _Out_opt_ LONG *plExtra);                \
                                                                                        \
                BOOL WINAPI DetourSetCodeModule##x(_In_ HMODULE hModule,                \
                                                   _In_ BOOL fLimitReferencesToModule);

DETOUR_OFFLINE_LIBRARY(X86)
DETOUR_OFFLINE_LIBRARY(X64)
DETOUR_OFFLINE_LIBRARY(ARM)
DETOUR_OFFLINE_LIBRARY(ARM64)
DETOUR_OFFLINE_LIBRARY(IA64)

#            undef DETOUR_OFFLINE_LIBRARY

//////////////////////////////////////////////////////////////////////////////
//
// Helpers for manipulating page protection.
//

_Success_(return != FALSE) BOOL WINAPI
    DetourVirtualProtectSameExecuteEx(_In_ HANDLE hProcess,
                                      _In_ PVOID pAddress,
                                      _In_ SIZE_T nSize,
                                      _In_ DWORD dwNewProtect,
                                      _Out_ PDWORD pdwOldProtect);

_Success_(return != FALSE) BOOL WINAPI DetourVirtualProtectSameExecute(_In_ PVOID pAddress,
                                                                       _In_ SIZE_T nSize,
                                                                       _In_ DWORD dwNewProtect,
                                                                       _Out_ PDWORD pdwOldProtect);
#            ifdef __cplusplus
}
#            endif  // __cplusplus

//////////////////////////////////////////////////////////////////////////////

#            define MM_ALLOCATION_GRANULARITY 0x10000

//////////////////////////////////////////////////////////////////////////////

#        endif  // DETOURS_INTERNAL
#    endif      // __cplusplus

#endif  // _DETOURS_H_
//
////////////////////////////////////////////////////////////////  End of File.
